home *** CD-ROM | disk | FTP | other *** search
/ The Apple Sales & Market…urce Library 1999 January / ARL Jan 99 CD 2.iso / Application Library / Desktop Publishing⁄Graphics / Creator2 / Other Stuff You Can Install! / Search 3.1.1 / Search® 3.1 CD Installer / SearchÆ 3.1 CD Installer / Multi-Ad SearchÆ 3.1.rsrc / STR#_8322.txt < prev    next >
Encoding:
Text File  |  1996-06-14  |  7.6 KB  |  497 lines
  1. Constants:
  2.  
  3.     Permissions: rd=readOnly; sc=lockSecure; up=lockUpdate; dl=lockDelete
  4.  
  5.                  sh=lockShared; ex=lockExclusive
  6.  
  7.     Boolean: t=TRUE; f=FALSE
  8.  
  9.  
  10.  
  11. Pointer parameters are specified as hex or decimal addresses and are prefixed by @.
  12.  
  13. Numbers are assumed to be decimal unless prefixed by $.
  14.  
  15. The following can be either an address or a dynamic variable name:
  16.  
  17.      View buffers
  18.  
  19.      Lock list handles
  20.  
  21.      SRSave handles
  22.  
  23.  
  24.  
  25. Database Operations:
  26.  
  27.  
  28.  
  29. ISOCreate (fileName, vRefNum, creator, fileType, extdType, imageFileType, permission,
  30.  
  31.      recoverMode, password)
  32.  
  33. ISOOpen (fileName, vRefNum, creator, fileType, extdType, imageFileType, permission,
  34.  
  35.      recoverMode, password, forceFind)
  36.  
  37. ISOSetCurrentDB (aDBREfNumber);
  38.  
  39. ISOGetCurrentDBRefNum (VAR theCurrentDBsRefNum) <- theResult
  40.  
  41. ISOClose
  42.  
  43. ISOResetStatus (fileName, vRefNum) <- theResult
  44.  
  45. ISOChgPassword (oldPass, newPass)
  46.  
  47. ISOIdle
  48.  
  49.  
  50.  
  51. ISOCheck (fName, showProgress, fullCheck, @problemRec) <- theResult
  52.  
  53. ISORepair (@problemRec, showProgress) <- repaired
  54.  
  55.  
  56.  
  57. ISOError <- theResult
  58.  
  59. ISOErrText (err) <- theText
  60.  
  61. ISOPushError (@errProc, @var)
  62.  
  63. ISOPopError
  64.  
  65.  
  66.  
  67. ISOSetExtProc (@makeProc, @findProc)
  68.  
  69.  
  70.  
  71. ISOCountFiles <- theResult
  72.  
  73. ISOCreateExtFile (fileName, vRefNum, startFileSize, maxFileSize)
  74.  
  75. ISOSelectFile (fileNum)
  76.  
  77. ISOGetFileSize (fileNum) <- blksUsed, blksAvailable, maxFileSize
  78.  
  79. ISOSetFileSize (fileNum, newBlkCount, maxFileSize)
  80.  
  81. ISOGetRefNum (fileNum) <- fileRefNum
  82.  
  83. ISOGetTime <- crTime, modTime, reorgTime
  84.  
  85.  
  86.  
  87. ISOHoldIO
  88.  
  89. ISOFlushIO
  90.  
  91.  
  92.  
  93. ISOUnloadSeg
  94.  
  95.  
  96.  
  97.  
  98.  
  99. File Operations:
  100.  
  101.  
  102.  
  103. FCreate (fileName, fType)
  104.  
  105. FConnect (childFile, parentFile)
  106.  
  107. FGrab (fileName, permission, wait)
  108.  
  109. FLockTest (fileName, permission) <- theResult
  110.  
  111. FLockExists (fileName, permission) <- theResult
  112.  
  113. FDelete (fileName)
  114.  
  115. FEmpty (fileName)
  116.  
  117. FGetTime (fileName) <- crTime, modTime, reorgTime
  118.  
  119. FSetEncryption (fileName, key)
  120.  
  121.  
  122.  
  123.  
  124.  
  125. Structured Record Operations:
  126.  
  127.  
  128.  
  129. SROpen (viewName) <- vwRefNum
  130.  
  131. SRClose (vwRefNum)
  132.  
  133. SRSelectKey (vwRefNum, keyName)
  134.  
  135. SRGetCurrKey (vwRefNum) <- keyName
  136.  
  137. SRSetBalance (fileName, keyName, balance)
  138.  
  139. SRSize (fileName) <- theResult
  140.  
  141.  
  142.  
  143. SRInsert (vwRefNum, @viewBuffer)
  144.  
  145. SRGrab (vwRefNum, permission, wait)
  146.  
  147. SRLockTest (vwRefNum, permission) <- theResult
  148.  
  149. SRLockExists (vwRefNum, permission) <- theResult
  150.  
  151. SRRead (vwRefNum, @viewBuffer, permission, wait)
  152.  
  153. SRUpdate (vwRefNum, @viewBuffer)
  154.  
  155. SRDelete (vwRefNum)
  156.  
  157. SRDeleteWithNext (vwRefNum, wrap, exactMatch, lastField, @viewBuffer,
  158.  
  159.      permission, wait) <- theResult
  160.  
  161. SRDeleteWithPrev (vwRefNum, wrap, exactMatch, lastField, @viewBuffer,
  162.  
  163.      permission, wait) <- theResult
  164.  
  165.  
  166.  
  167. SRFindFirst (vwRefNum, @viewBuffer, lastField, exactMatch, permission,
  168.  
  169.      wait) <- theResult
  170.  
  171. SRFindLast (vwRefNum, @viewBuffer, lastField, exactMatch, permission,
  172.  
  173.      wait) <- theResult
  174.  
  175. SRFindRange (vwRefNum, @viewBuffer1, @viewBuffer2, lastField, exactMatch,
  176.  
  177.      permission, wait) <- theResult
  178.  
  179. SRGetCount (vwRefNum) <- theResult
  180.  
  181. SRNext (vwRefNum, wrap, exactMatch, lastField, @viewBuffer, permission,
  182.  
  183.      wait) <- theResult
  184.  
  185. SRPrevious (vwRefNum, wrap, exactMatch, lastField, @viewBuffer, permission,
  186.  
  187.      wait) <- theResult
  188.  
  189. SRPositionFirst (vwRefNum, @viewBuffer, permission, wait) <- theResult
  190.  
  191. SRPositionLast (vwRefNum, @viewBuffer, permission, wait) <- theResult
  192.  
  193. SRPosition (vwRefNum, thePos, @viewBuffer, permission, wait) <- theResult
  194.  
  195. SRGetPosition (vwRefNum) <- theResult
  196.  
  197.  
  198.  
  199. SRSave (vwRefNum, saveRecHdl)
  200.  
  201. SRRestore (vwRefNum, saveRecHdl)
  202.  
  203. SRGetRecID (fileName) <- theRec
  204.  
  205. SRSetRecID (fileName, theRec)
  206.  
  207. SRCurrentRecord (fName) <- theResult
  208.  
  209. SRClearCurrent (vwRefNum)
  210.  
  211. SRInitVwBuff (vwRefNum, @viewBuffer)
  212.  
  213. SRClear (vwRefNum, @viewBuffer)
  214.  
  215.  
  216.  
  217.  
  218.  
  219. View Maintenance:
  220.  
  221.  
  222.  
  223. SRNewView (viewName)
  224.  
  225. SROpenView (viewName)
  226.  
  227. SRViewNewField (localName, fldType, fldCount, fldLength,
  228.  
  229.      fileName, fieldName)
  230.  
  231. SRViewNewKey (localName, fileName, keyName)
  232.  
  233. SRViewNewFile (fName, statusMask)
  234.  
  235. SRCloseView
  236.  
  237. SRDeleteView (viewName)
  238.  
  239.  
  240.  
  241.  
  242.  
  243. Unstructured File Operations:
  244.  
  245.  
  246.  
  247. USOpen (fileName) <- usRefNum
  248.  
  249. USClose (usRefNum)
  250.  
  251. USPosition (usRefNum, posMode, position)
  252.  
  253. USGetPosition (usRefNum) <- theResult
  254.  
  255. USRead (usRefNum, count, @buffer)
  256.  
  257. USWrite (usRefNum, count, @buffer)
  258.  
  259. USGrab (usRefNum, start, count, permission, wait)
  260.  
  261. USLockTest (usRefNum, start, count, permission) <- theResult
  262.  
  263. USLockExists (usRefNum, start, count, permission) <- theResult
  264.  
  265. USGetEOF (usRefNum) <- theResult
  266.  
  267. USSetEOF (usRefNum, logEOF)
  268.  
  269.  
  270.  
  271.  
  272.  
  273. Reorganization:
  274.  
  275.  
  276.  
  277. REUpgrade (showProgess, progressProc)
  278.  
  279. REUpdate (showProgress, progressProc)
  280.  
  281. REBegin (fileName)
  282.  
  283. RENewField (newName, newType, newLength, newCount)
  284.  
  285. RERmveField (fieldName)
  286.  
  287. REChgField (fieldName, newType, newLength, newCount)
  288.  
  289. RENewKey (keyName, fldCount {, fldName, fldLength, ascending}‚Ķ, MaintainCount, ULCase,
  290.  
  291.      dupAllowed)
  292.  
  293. RERmveKey (keyName)
  294.  
  295. REChgKey (keyName, fldCount {, fldName, fldLength, ascending}‚Ķ, ULCase,
  296.  
  297.      dupAllowed)
  298.  
  299. REAddCon (connectFile)
  300.  
  301. RERmveCon (connectFile)
  302.  
  303. REEnd (showProgress, progressProc)
  304.  
  305.  
  306.  
  307.  
  308.  
  309. Static Block Operations:
  310.  
  311.  
  312.  
  313. SBCreate (blockType, blockID, blockSize, @data)
  314.  
  315. SBGrab (blockType, blockID, permission, wait)
  316.  
  317. SBLockTest (blockType, blockID, permission) <- theResult
  318.  
  319. SBLockExists (blockType, blockID, permission) <- theResult
  320.  
  321. SBDelete (blockType, blockID)
  322.  
  323. SBResize (blockType, blockID, newSize)
  324.  
  325. SBGetSize (blockType, blockID) <- theResult
  326.  
  327. SBRead (blockType, blockID, @data)
  328.  
  329. SBUpdate (blockType, blockID, @data)
  330.  
  331.  
  332.  
  333.  
  334.  
  335. Database Schema Queries:
  336.  
  337.  
  338.  
  339. SQCountFiles <- theResult
  340.  
  341. SQGetIndFileInfo (fileNum) <- fileName, fileType, fieldCount, keyCount, conCount
  342.  
  343. SQGetFileInfo (fileName) <- fileName, fileType, fieldCount, keyCount, conCount | false
  344.  
  345. SQGetIndFieldInfo (fileName, fieldNum) <- fieldName, fieldType, fieldLength,
  346.  
  347.      fieldCount
  348.  
  349. SQGetFieldInfo (fileName, fieldName) <- fieldName, fieldType, fieldLength,
  350.  
  351.      fieldCount | false
  352.  
  353. SQGetIndKeyInfo (fileName, keyNum) <- keyName, dupAllowed, ULCase, fieldCount
  354.  
  355.      {, fieldName, fieldLength}‚Ķ
  356.  
  357. SQGetKeyInfo (fileName, keyName) <- keyName, dupAllowed, ULCase, fieldCount
  358.  
  359.      {, fieldName, fieldLength}‚Ķ | false
  360.  
  361. SQGetIndConnection (fileName, conNum) <- connectFile
  362.  
  363. SQGetConnection (fileName, connectFile) <- theResult
  364.  
  365.  
  366.  
  367.  
  368.  
  369. Utilities:
  370.  
  371.  
  372.  
  373. Encrypt (@data, dataSize, key)
  374.  
  375. Decrypt (@data, dataSize, key)
  376.  
  377. Compress (dataHdl) <- theResult
  378.  
  379. Decompress (dataHdl) <- theResult
  380.  
  381.  
  382.  
  383.  
  384.  
  385. Debugger Functions:
  386.  
  387.  
  388.  
  389. DebugClearTxt (n)
  390.  
  391. DebugWrite (n, aStr)
  392.  
  393. DebugWriteln (n, aStr)
  394.  
  395. DebugAudit (n)
  396.  
  397.  
  398.  
  399.  
  400.  
  401. Locking Operations:
  402.  
  403.  
  404.  
  405. ExtLock (theType, theData, firstByte, count, permission, wait) <- theResult
  406.  
  407. ExtLockTest (theType, theData, firstByte, count, permission) <- theResult
  408.  
  409. ExtLockExists (theType, theData, firstByte, count, permission) <- theResult
  410.  
  411.  
  412.  
  413. GetLockNumber (theLocks) <- theLocks
  414.  
  415. LockStatus (theLocks) <- theStatus
  416.  
  417. ReleaseLock (theLocks)
  418.  
  419.  
  420.  
  421. SetOwner (ownerID)
  422.  
  423. GetOwner <- ownerID
  424.  
  425. LockConflicts (theLocks) <- lockCount, lockList
  426.  
  427. LockQuery (lockNum) <- lockInfo
  428.  
  429.  
  430.  
  431. PollLocks (theLocks)
  432.  
  433. PushPollProc (@pollProc,@var)
  434.  
  435. PopPollProc
  436.  
  437. GetPollParams <- msg, minTime, maxTime, dlogID, canCancel
  438.  
  439. SetPollParams (msg, minTime, maxTime, dlogID, canCancel)
  440.  
  441.  
  442.  
  443.  
  444.  
  445. Messaging Operations:
  446.  
  447.  
  448.  
  449. CountUsers <- userCount
  450.  
  451. GetUserName (userNum) <- userName
  452.  
  453. GetUserNum (userName) <- userNum
  454.  
  455. GetIndUserNum (n) <- userNum
  456.  
  457. GetMyUserName <- userName
  458.  
  459. SetMyUserName (userName)
  460.  
  461.  
  462.  
  463. NewMsgPtr (blkCount) <- outMsgPtr
  464.  
  465. DisposeMsgPtr (msgPtr)
  466.  
  467. MessageSend (theMsg, async)
  468.  
  469. ReadMessage (theMsg) <- theResult
  470.  
  471. ReadMessageOfType (theType, theMsg) <- theResult
  472.  
  473. MessageCount <- theCount
  474.  
  475. MessageTypeCount (msgType) <- theCount
  476.  
  477. DisposeMsg (theMsg)
  478.  
  479.  
  480.  
  481.  
  482.  
  483. Additional Interpreter Commands:
  484.  
  485.  
  486.  
  487. New (vwRefNum, varName)
  488.  
  489. Dispose (varName)
  490.  
  491. Ignore (procname [, procName]‚Ķ | All)
  492.  
  493. Remember (procName [, procName]‚Ķ | All)
  494.  
  495.  
  496.  
  497.